getFieldList

Returns a list of database fields in the active database. This list includes all of the user fields, and the built-in fields that could potentially be modified by an external application.

Sample Request

<mmRequest command="getFieldList" station="ID" [version="1"] [client=""] [userData=""] />

Request Notes

None

Sample Reply

<mmReply command="getFieldList" station="ID" version="1" [userData=""] status="ok">
	<contents>
		<fields>
			<field id="3" type="99" len="0" name="Category" abbr="CAT" hidden="0" locked="0"/>
			<field id="11" type="9" len="1" name="Mark Status" abbr="MK" hidden="0" locked="0"/>
			<field id="12" type="13" len="5" name="Run Time" abbr="RT" hidden="0" locked="0"/>
			<field id="21" type="99" len="0" name="Dayparting" abbr="DP" hidden="0" locked="0"/>
			<field id="22" type="99" len="0" name="Packet" abbr="PK" hidden="0" locked="0"/>
			<field id="46" type="2" len="3" name="Rotation Weight" abbr="WT" hidden="0" locked="0"/>
			<field id="47" type="2" len="2" name="Max Per Day" abbr="DayMax" hidden="0" locked="0"/>
			<field id="51" type="11" len="0" name="Start Day/Hour" abbr="Starts" hidden="0" locked="0"/>
			<field id="52" type="11" len="0" name="End Day/Hour" abbr="Ends" hidden="0" locked="0"/>
			<field id="53" type="2" len="4" name="Kill Plays" abbr="KillPly" hidden="0" locked="0"/>
			<field id="102" type="1" len="255" name="Artist Name" abbr="ART" hidden="0" locked="0"/>
			<field id="103" type="1" len="255" name="Song Title" abbr="TTL" hidden="0" locked="0"/>
			<field id="104" type="22" len="64" name="Artist Keywords" abbr="ARTS" hidden="0" locked="0"/>
			<field id="105" type="22" len="64" name="Title Keywords" abbr="TTLS" hidden="0" locked="0"/>
			<field id="106" type="22" len="64" name="CD/LP Titles" abbr="LP" hidden="0" locked="0"/>
			<field id="107" type="1" len="16" name="Source Type" abbr="SRC" hidden="0" locked="0"/>
			<field id="108" type="1" len="64" name="Audio Notes" abbr="Audio" hidden="1" locked="0"/>
		</fields>
	</contents>
</mmReply>

Reply Notes

The list of fields is returned in the contents/fields section. Each field has a field tag.

The following attributes are available for each field:

KEY	DESCRIPTION
Id	Internal field ID number
type	MusicMaster field type code: 1=Text 2=Numeric-Fixed 3=Numeric-Float 4=Currency 9=Boolean 11=Date 12=Time 13=Length 21=Keyword-Single 22=Keyword-Multiple 31=Attribute-Single 32=Attribute-In/Out 33=Attribute-Combo 34=Attribute-Multiple 72=Memo 99=Pointer
abbr	User field abbreviated name
hidden	1=field is hidden 0=field is visible
len	Maximum field entry length where applicable
level	1=Enterprise 2=Station 3 =Category field level
locked	1=field locked from changes 0=field is not locked
name	User full field name
overridable	1=field is overridable 2=field is not overridable
priority	1=primary field 2=secondary field 0=other

Compatibility and Version Info

Available in all versions.

The hidden attribute requests require API version 5014 or later.